home *** CD-ROM | disk | FTP | other *** search
/ Aminet 19 / Aminet 19 (1997)(GTI - Schatztruhe)[!][Jun 1997].iso / Aminet / misc / sci / wol_fpu.lha / ChipMunk / wol / README
Text File  |  1996-05-18  |  9KB  |  230 lines
  1.  
  2. This is wol, a IC layout tool written by Mass Sivilotti and maintained
  3. under Unix by John Lazzaro. Wol is distributed under the GNU General
  4. Public License; see file COPYING in this directory for more
  5. information.
  6.  
  7. If you have a web browser, the best way to learn about what Wol is
  8. and how to install it is to pick up the latest version of the webdoc
  9. Web pages (webdocX.XX.tar.gz, where X.XX is a version number) from the
  10. same place you picked up this file. Once you have this Web tree
  11. untarred, point your Web browser (examples of Web browsers include
  12. Mosaic, Lynx, Netscape, and tkWWW) to webdoc/index.html for the home
  13. page of the Chipmunk tools, and to webdoc/compile/compile.html for
  14. compilation instructions.
  15.  
  16. The rest of this file is written assuming that you don't have access
  17. to a Web browser -- all text is copied from webdoc pages
  18. verbatim. I'll do my best to keep this file up to date, but the Web
  19. tree is now the primary documentation for all aspects of the Chipmunk
  20. system.
  21.  
  22. ---------
  23.  
  24. Note that the web pages treat Wol and Wolcomp together, so much of the
  25. documentation below, which I took from the web pages, talk about
  26. Wolcomp too. You'll need to pickup the wolcomp tar file (from the same
  27. place you picked this file up) to get wolcomp; it is not included in
  28. this tar file.
  29.  
  30. Wol and Wolcomp 
  31. ---------------
  32.  
  33. Wol is a graphical environment for IC mask layout. Wolcomp is a
  34. simple cell compiler, embedded in C, for the compilation of leaf
  35. cells generated by Wol into a complete chip. The original versions
  36. of Wol and Wolcomp were written by Carver Mead; the version
  37. included in the Chipmunk package was primarily written by
  38. Massimo Sivilotti, with major contributions by Glenn Gribble. The
  39. name Wol originates from the children's book Winnie the Pooh.
  40. Features of Wol and Wolcomp include: 
  41.  
  42. Cell editing 
  43.    The Manhattan-geometry leaf-cell editor in Wol has two
  44.    major differences (advantages or disadvantages depending on
  45.    your preferences) compared with Magic: CIF layers are
  46.    drawn directly, and box drawing uses a rubber-banding
  47.    interface. Preferences concerning the mechanics of drawing
  48.    layout is a primary reason users avoid or embrace Wol. 
  49.  
  50. Cell composition 
  51.    Wolcomp, a simple cell compiler embedded in C, supports
  52.    composition of leaf cells drawn by Wol under program
  53.    control, allowing the construction of parameterizable
  54.    macrocell generators. Wol includes an full-featured viewer
  55.    of Wolcomp compositions that also supports manual
  56.    composition; however, manual composition in Wol is
  57.    rudimentary and not suitable for large manually-composed
  58.    designs. 
  59.  
  60. Netlist extraction 
  61.    Wol includes a netlist extraction function, that produces
  62.    netlist files suitable for net comparison with schematic
  63.    netlists generated by Log. Dense 4600 micron by 6800
  64.    micron chips (lambda = 1 micron), with over 50,000
  65.    transistors, have been successfully extracted with Wol. Wol
  66.    supports post-extraction visualization of netlist connectivity.
  67. Rudimentary DRC 
  68.    The Wol leaf-cell editor and composition viewer supports
  69.    rudimentary post-layout DRC, but cannot DRC entire chips.
  70.    Wol designers typically use Magic (or another tool) to do a
  71.    full-layout DRC before tapeout. Tools exist to convert Wol
  72.    CIF output to a form compatible with Magic, and to create
  73.    flattened CIF for use in Magic DRC checking. 
  74.  
  75. Wol and Wolcomp have relatively few users, due to the popularity
  76. of Magic and the commercial tool LEdit. Some users do use Wol
  77. extensively to create IC designs for fabrication through MOSIS; I
  78. have designed over 20 chips using Wol and Wolcomp since the Unix
  79. port of the Chipmunk tools, using Magic for auxiliary DRC
  80. purposes only. For some users, the advantages of cell compilation
  81. outweigh other issues. 
  82.  
  83. Platforms and Requirements 
  84. --------------------------
  85.  
  86. The Chipmunk tools require an ANSI c compiler (typically GCC) and
  87. X11 (R4, R5, or R6). Color displays with 8 bits per pixel work best for
  88. Chipmunk (other than 8bpp can be problematic), although Log supports
  89. black-and-white displays. An HTML browser (like Mosaic or Lynx or
  90. Netscape) is also necessary to access the Chipmunk documentation.
  91.  
  92. These are the currently supported platforms, with details of
  93. platform-specific requirements: 
  94.  
  95.    Apple Macintosh, AU/X. 
  96.    DEC MIPS-based DECstations 
  97.    HP Series 300/400, HPUX. 
  98.    HP Series 700, HPUX. The HP-supplied cc, with extra-cost
  99.    ANSI option, will also compile Chipmunk. 
  100.    IBM PC and Compatibles, FreeBSD. 
  101.    IBM PC and Compatibles, Linux, Slackware. 
  102.    IBM RS/6000. The IBM xlc compiler is known to compile
  103.    Chipmunk; gcc has not been tested. 
  104.    SGI. Chipmunk known to work on Indigo and Challenge, no
  105.    others were tested. The SGI cc is recommended. 
  106.    Sun SPARC, Solaris 1.X (SunOS 4.X). 
  107.    Sun SPARC, Solaris 2.X (SunOS 5.X). 
  108.    IBM PC and Compatibles, OS/2. 
  109.  
  110.      OS/2 Requirements 
  111.  
  112.      Only the Log system (diglog, analog and loged) is ported. However,
  113.      porting Log meant porting Psys: if you are an OS/2 user who is 
  114.      interested in porting Wol, the Log port gives you a good head
  115.      start.
  116.  
  117.      Here are the requirements for Log:
  118.  
  119.      The icc compiler. Not known if gcc will work also, please let
  120.      me know if you try gcc. 
  121.  
  122.      OS/2 with TCPIP and X11 (PMX). OS/2 revisions 2.1 and higher
  123.      should work, but all current testing has been done using WARP.
  124.      TCPIP version 2.0 with the "latest CSD's" to the Base kit is also
  125.      needed, as is the X-server (PMX) kit. 
  126.  
  127. If your configuration is different than the ones described above,
  128. only take the package if you feel confident in your C/Unix abilities
  129. to do the porting required. If you do successfully port to a new
  130. architecture or OS, send us the changes required, and we will
  131. incorporate your port in the next release of the chipmunk tools.
  132.  
  133. Here is the know status of Chipmunk on popular platforms not currently
  134. supported
  135.  
  136.    IBM PC-Compatibles, MS-DOS or Windows. Several failed
  137.    porting attempts have occurred. However, a new porting effort
  138.    is underway by a group in Europe. Contact me for details.
  139.  
  140.    IBM PC-Compatibles, NextStep. No ports are in progress, to
  141.    my knowledge. 
  142.  
  143.    Apple Macintosh, MacOS. No ports are in progress, to my
  144.    knowledge. 
  145.  
  146.    DEC Alpha, OSF/1 or VMS. Several Alpha ports have failed,
  147.    because of 64-bit compatibility problems with binary file I/O. I
  148.    don't think the port is impossible, just more difficult than the
  149.    successful ports listed above. 
  150.  
  151. To get wol running, first bring over a copy of psys-Y.YY.tar.Z (where
  152. Y.YY is a version number), available at the same place this file was
  153. found. Untar and make psys per instructions in the package.  After
  154. psys is installed, you can start to install wol.
  155.  
  156. Compiling Wol 
  157. -------------
  158.  
  159. This document assumes that you have successfully compiled the 
  160. Psys libraries. This document also assumes that you have
  161. uncompressed and untarred the Wol file, and installed it in the 
  162. chipmunk directory. Note that Wol has not been ported to OS/2.
  163.  
  164. Begin by descending to the wol directory. Edit the file 
  165. Makefile, and make any necessary changes. Comments in the
  166. Makefile will guide you through these changes; the changes are
  167. labeled with the markers (1), (2), (3), ect. Once these changes are
  168. made, execute the command 
  169.  
  170. make install 
  171.  
  172. If things are working correctly, a long series of compilations,
  173. linkings, and file movements should occur without error. This will
  174. create the program chipmunk/bin/wol. 
  175.  
  176. To do a basic functional test of Wol, execute the following
  177. command in the wol directory: 
  178.  
  179. ./wol -tSCGA 
  180.  
  181. Two windows should appear, mylib and newcrt. To leave the
  182. program, press q. To learn more about using wol, see the user
  183. documentation. 
  184.  
  185. If you have problems compiling wol, I'd be happy to offer
  186. suggestions.Send email to lazzaro@cs.berkeley.edu and include the
  187. following information.
  188.  
  189.    Complete machine configuration, including machine type, OS
  190.    revision, compilers, and X servers. 
  191.  
  192.    A listing of the output from the failed compilation process, or
  193.    any messages printed by a Chipmunk program or the OS or X
  194.    when an error occurs.
  195.  
  196.    Details of any changes you have made to the distribution before
  197.    this compilation. 
  198.  
  199.    The effects of following any advice given in the compilation
  200.    instructions. 
  201.  
  202. Documentation for Wol 
  203. ----------------------
  204.  
  205. All of the documentation for using Wol is included in the webdoc
  206. package. See:
  207.  
  208. webdoc/document/wol/index.html
  209.  
  210. ----
  211.  
  212. If using the Webdoc documention isn't practical, then you can 
  213. directly look at the complete Postcript manual for wol, included
  214. as wol/wolman/wol.ps. The wolman directory also includes complete
  215. TeX source for this manual.
  216.  
  217. To help understand how to use Wolcomp and Wol in a real
  218. chip design, with the current version of the tools, serious users
  219. will want to check out the examples package, which contains a
  220. VLSI chip design done using Wol and Wolcomp. It's available the
  221. same place you picked up the Chipmunk tools, as a tar file 
  222. that has "examples" in its title, probably examples.tar.gz.
  223.  
  224. Bug fixes and porting are the major additions to Wol in this
  225. release.
  226.  
  227.  
  228.                         --john lazzaro
  229.  
  230.